﻿/* Copyright © 2008 by Marcus Bengtsson - makkbe@gmail.com   
 * 
 * This file is part of TaskDispatcher.
 *
 * TaskDispatcher is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * TaskDispatcher is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with TaskDispatcher.  If not, see <http://www.gnu.org/licenses/>.
 **/

using System;
using System.Collections.Generic;
using System.Text;

namespace Dispatcher
{
    public interface ITask
    {
        /// <summary>
        /// Executes the current task.
        /// 
        /// This method shall be implemented so that the job specified for the
        /// task gets executed.
        /// </summary>
        /// <returns>True if successful, otherwise false</returns>
        bool Execute();

        /// <summary>
        /// Returns the name of the task.
        /// </summary>
        /// <returns>The Task name</returns>
        string Name
        {
            get;
        }

        /// <summary>
        /// Returns the dispatch interval in milliseconds.
        /// </summary>
        DispatchInterval Interval
        {
            get;
        }
    }
}
